/*
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
package interfaces;

import input.IRCCommand;

/**
 * A utopia entity that has calculable effects
 * 
 * 
 */
public interface CalculableUtopiaEntity {
   /**
    * @return the array of caps for the formulas. Returns null if the caps are incorrectly formatted
    */
   String[] getCap();

   /**
    * Replaces the placeholders in the formulas with numbers from the command
    * 
    * @param command
    *           The command that was issued
    * @return array of String containing the formulas. Returns null if the formulas are incorrectly formatted
    */
   String[] getFormula(IRCCommand command);

   /**
    * @return the name of the object
    */
   String getName();

   /**
    * @return the array of result strings. null if there isn't one result string for each formula
    */
   String[] getResult();
}
